/*
 * Copyright (c) 2011, Nikolaus Moll
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * * Neither the name of the gradecalculator.net nor the
 *   names of its contributors may be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
package net.gradecalculator.plugin.importer.interfaces;

import java.util.List;

import net.gradecalculator.plugin.importer.data.ImportedExaminationResult;

public interface ICommonImportPlugin {
	/**
	 * Returns the plug-in's name shown in the application menu
	 * @return name of plug-in
	 */
	String getName();
	
	/**
	 * Returns the version information of the plug-in
	 * @return version information
	 */
	String getVersion();
	
	/**
	 * Returns the status line text which is shown when the plug-in is hovered
	 * @return status line text
	 */
	String getStatusLineText();

	/**
	 * Returns the list of examination results
	 * @return list of results
	 */
	List<ImportedExaminationResult> getResults();
	
	/**
	 * Returns the name of the university
	 * @return university's name
	 */
	String getUniversity();
	
	/**
	 * Returns the aimed degree of studies
	 * @return name of degree, e.g. 'Bachelor', 'Master'
	 */
	String getDegree();

	/**
	 * Returns name of the course of studies
	 * @return name
	 */
	String getCourseOfScience();

	/**
	 * Returns the semester of the student's examination regulations
	 * The semester should not have any spaces or special characters, and should contain
	 * the beginning year only
	 * @return semester name, e.g. 'SS2008', 'WS2010'
	 */
	String getSemester();
	
	/**
	 * Returns the name of the student
	 * @return student's name
	 */
	String getStudent();

	/**
	 * Returns a list of the selected module lists (focus) by the student
	 * @return list of modules
	 */
	List<String> getSelectedModuleLists();

}
